<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.7"/>
<title>RuLaw.NET: RuLaw.IApiCaller Interface Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">RuLaw.NET
   &#160;<span id="projectnumber">1.5.6</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.7 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('interface_ru_law_1_1_i_api_caller.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Properties</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="interface_ru_law_1_1_i_api_caller-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">RuLaw.IApiCaller Interface Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p> 
 <a href="interface_ru_law_1_1_i_api_caller.html#details">More...</a></p>

<p>Inherited by RuLaw.ApiCaller.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa75a3dbce9ecde91f508a478a39c82ad"><td class="memItemLeft" align="right" valign="top">IRestResponse&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_ru_law_1_1_i_api_caller.html#aa75a3dbce9ecde91f508a478a39c82ad">Call</a> (string resource, IDictionary&lt; string, object &gt; parameters=null, IDictionary&lt; string, object &gt; headers=null)</td></tr>
<tr class="separator:aa75a3dbce9ecde91f508a478a39c82ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a883c77fe5559018f3ff84362541cff09"><td class="memItemLeft" align="right" valign="top">IRestResponse&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_ru_law_1_1_i_api_caller.html#a883c77fe5559018f3ff84362541cff09">Call&lt; T &gt;</a> (string resource, IDictionary&lt; string, object &gt; parameters=null, IDictionary&lt; string, object &gt; headers=null)</td></tr>
<tr class="separator:a883c77fe5559018f3ff84362541cff09"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:adc668d57e1e786e6a83a589c23d09827"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_ru_law_1_1_i_api_caller.html#adc668d57e1e786e6a83a589c23d09827">ApiToken</a><code> [get]</code></td></tr>
<tr class="separator:adc668d57e1e786e6a83a589c23d09827"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0945469a69021c95a20a9f12c1aec136"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_ru_law_1_1_i_api_caller.html#a0945469a69021c95a20a9f12c1aec136">AppToken</a><code> [get]</code></td></tr>
<tr class="separator:a0945469a69021c95a20a9f12c1aec136"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af23a0ecbaf76329c8a5670093cb8c642"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespace_ru_law.html#acb48d903047d8f9b155d3fed4a1e9219">ApiDataFormat</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_ru_law_1_1_i_api_caller.html#af23a0ecbaf76329c8a5670093cb8c642">Format</a><code> [get]</code></td></tr>
<tr class="separator:af23a0ecbaf76329c8a5670093cb8c642"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Entry point for <a class="el" href="class_ru_law_1_1_ru_law.html">RuLaw</a> API.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aa75a3dbce9ecde91f508a478a39c82ad"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">IRestResponse RuLaw.IApiCaller.Call </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>resource</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IDictionary&lt; string, object &gt;&#160;</td>
          <td class="paramname"><em>parameters</em> = <code>null</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IDictionary&lt; string, object &gt;&#160;</td>
          <td class="paramname"><em>headers</em> = <code>null</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Makes a remote call to Russian State Duma REST web service and returns it's response.</p>
<p>Uses value of <a class="el" href="interface_ru_law_1_1_i_api_caller.html#af23a0ecbaf76329c8a5670093cb8c642">Format</a> for data exchange.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">resource</td><td>Relative URL of web resource to be used. Base endpoint URL is predefined by implentation.</td></tr>
    <tr><td class="paramname">parameters</td><td>Map of query parameters names/values.</td></tr>
    <tr><td class="paramname">headers</td><td>Map of HTTP headers names/values.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Response from REST web service.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">ArgumentNullException</td><td>If <em>resource</em>  is a <code>null</code> reference.</td></tr>
    <tr><td class="paramname">ArgumentException</td><td>If <em>resource</em>  is string.Empty string.</td></tr>
    <tr><td class="paramname"><a class="el" href="class_ru_law_1_1_ru_law_exception.html">RuLawException</a></td><td>If error occurs during the processing of web request, or if request was invalid.</td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a883c77fe5559018f3ff84362541cff09"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">IRestResponse&lt;T&gt; <a class="el" href="interface_ru_law_1_1_i_api_caller.html#aa75a3dbce9ecde91f508a478a39c82ad">RuLaw.IApiCaller.Call</a>&lt; T &gt; </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>resource</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IDictionary&lt; string, object &gt;&#160;</td>
          <td class="paramname"><em>parameters</em> = <code>null</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IDictionary&lt; string, object &gt;&#160;</td>
          <td class="paramname"><em>headers</em> = <code>null</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Makes a remote call to Russian State Duma REST web service and returns deserialized generic response.</p>
<p>Uses value of <a class="el" href="interface_ru_law_1_1_i_api_caller.html#af23a0ecbaf76329c8a5670093cb8c642">Format</a> for data exchange.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">T</td><td>Type of object that is created from web service's response.</td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">resource</td><td>Relative URL of web resource to be used. Base endpoint URL is predefined by implementation.</td></tr>
    <tr><td class="paramname">parameters</td><td>Map of query parameters names/values.</td></tr>
    <tr><td class="paramname">headers</td><td>Map of HTTP headers names/values.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Generic response from REST web service.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname">ArgumentNullException</td><td>If <em>resource</em>  is a <code>null</code> reference.</td></tr>
    <tr><td class="paramname">ArgumentException</td><td>If <em>resource</em>  is string.Empty string.</td></tr>
    <tr><td class="paramname"><a class="el" href="class_ru_law_1_1_ru_law_exception.html">RuLawException</a></td><td>If error occurs during the processing of web request, or if request was invalid.</td></tr>
  </table>
  </dd>
</dl>
<div class="typeconstraint">
<dl><dt><b>Type Constraints</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em>T</em></td><td>&#160;:</td><td valign="top"><em>new()</em></td><td>&#160;</td></tr>
</table>
</dl>
</div>

</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="adc668d57e1e786e6a83a589c23d09827"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">string RuLaw.IApiCaller.ApiToken</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>API token, used to perform web requests. Must be obtained by developers.</p>

</div>
</div>
<a class="anchor" id="a0945469a69021c95a20a9f12c1aec136"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">string RuLaw.IApiCaller.AppToken</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Application token, used to perform web requests. Must be obtained by developers.</p>

</div>
</div>
<a class="anchor" id="af23a0ecbaf76329c8a5670093cb8c642"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespace_ru_law.html#acb48d903047d8f9b155d3fed4a1e9219">ApiDataFormat</a> RuLaw.IApiCaller.Format</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Data exchange format to use.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespace_ru_law.html">RuLaw</a></li><li class="navelem"><a class="el" href="interface_ru_law_1_1_i_api_caller.html">IApiCaller</a></li>
    <li class="footer">Generated on Wed Aug 6 2014 01:33:32 for RuLaw.NET by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
  </ul>
</div>
</body>
</html>
